Login and records implementation by ukumar-ks · Pull Request #122 · Keeper-Security/keeper-sdk-javascript

ukumar-ks · 2026-04-13T12:27:55Z

Login & Records Implementation

Summary

Adds KeeperSdk wrapper and interactive CLI examples for authentication and vault record operations.

Authentication

Password login — Master password authentication with retry logic and masked input.
Session token login — Login using an existing session token for pre-authenticated workflows.
Persistent login — Automatic session resumption via clone code from ~/.keeper/config.json.

Records

CRUD operations for vault records: list, get, add (v2/v3), update, delete, move, revision history, and password lookup with clipboard copy.

Sharing

Share and unshare records with other Keeper users via public key encryption.

socket-security · 2026-04-13T12:28:11Z

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	@types/node@20.19.39
	ts-node@10.9.2
	tsconfig-paths@4.2.0

View full report

tylerccarson

Overall, adding a more user-friendly way to using the keeperapi package is a great idea. Going forward, we should treat everything in @keeper-security/keeperapi as the core library (which is primarily used and maintained by the browser extensions team), and add a new npm package (@keeper-security/keeper-sdk-javascript) intended for the public audience that's a convenient wrapper of the core library.

I've added some code-level feedback to the proposed additions here, please take a look at those.

Other than that:

we use main, not release (not sure who pushed release?). PR should be re-targeted
not sure if you want to do this yet, but ultimately we'll need to setup an npm workflow that publishes just @keeper-security/keeper-sdk-javascript. I can work on creating the package on the npm side when the time comes.
the additions are Node-centric, but I have a feeling there will be users who want to use this package in the browser as well. So 1) does this work in the browser and 2) if so, there should be examples that demonstrate a little bit

tylerccarson · 2026-04-17T15:59:48Z

@@ -0,0 +1,22 @@
+{
+    "name": "keeper-sdk",


We're going to publish as a separate package called @keeper-security/keeper-sdk-javascript-- name here should be updated accordingly

I’ve updated the name field to @keeper-security/keeper-sdk-javascript as suggested.

tylerccarson · 2026-04-17T16:05:01Z

+        "types:ci": "tsc"
+    },
+    "dependencies": {
+        "@keeper-security/keeperapi": "17.1.0",


no change needed now-- but I will probably explore more formally re-organizing the project into npm workspaces after this. Then the packages will be implicitly linked, and share node_modules

Understood, we’ll keep it as is for now and change later.

tylerccarson · 2026-04-17T16:14:56Z

@@ -0,0 +1,36 @@
+export const SdkDefaults = {
+    CLIENT_VERSION: 'c17.0.0',


Not sure about whether we want to identify ourselves as Commander here with the c client version prefix

I've spoken with the backend team in the past already about adding a dedicated client version prefix for the js-sdk (i.e. js17.0.0), but not sure if any progress has been made.

@saldoukhov is that something you could help with? Or maybe @jgrein-keeper?

The backend does not seem to accept the client version yet. Testing with js17.0.0 was unsuccessful, and I am falling back to c17.0.0.

tylerccarson · 2026-04-17T16:23:18Z

+        return err.message || err.result_code || err.error || 'Unknown Keeper error'
+    }
+    if (err instanceof Error) return err.message
+    if (typeof err === 'string') return err


Could be a JSON string-- make want to attempt parsing as such first

Added parseJsonObjectIfPresent(s: string) helper to first check for JSON-like input and safely parse it using try/catch.

tylerccarson · 2026-04-17T16:23:32Z

+            } catch {}
+        }
+    }
+    if (typeof err === 'string') return err


tylerccarson · 2026-04-17T17:23:57Z

+    }
+
+    private static base64urlDecode(str: string): Buffer {
+        return Buffer.from(str.replace(/-/g, '+').replace(/_/g, '/'), 'base64')


use normal64Bytes from core lib

tylerccarson · 2026-04-17T17:30:40Z

+
+enum ResultCode {
+    Success = 'success',
+    OK = 'OK',


What is the difference between Success and OK?

Success is used in legacy executeRestCommand flows (e.g. record_add) where success is indicated via result_code === 'success'. OK is used in the newer typed record/protobuf modify path as a fallback status when no per-record status is returned, but the overall call succeeds.

tylerccarson · 2026-04-17T17:34:47Z

+    history: HistoryEntry[]
+}
+
+type RecordHistoryRequest = {


This and associated types should be moved to the code lib (src/commands.ts).

Addressed—moved this to commands.ts as requested. The remaining types (HistoryEntry and RecordHistoryResult) are SDK-level, post-processed/decrypted result shapes rather than raw command transport types, so they are kept at the SDK layer.

tylerccarson · 2026-04-17T17:35:52Z

+    return { recordUid, history }
+}
+
+function normalizeBase64(source: string): string {


use core lib function

tylerccarson · 2026-04-17T17:40:56Z

+
+## Prerequisites
+
+- Node.js 16+


Node 16 is pretty outdated, have you run these against it to be sure? We may want a specify a more recent minimum node version and not recommend something that probably has unpatched security vulnerabilties

Updated the recommended Node.js version from 16 to 22 LTS (or newer), as Node 20 is now in maintenance and any earlier versions are obsolete.

Login and records implementation int (#121)

f095827

ukumar-ks requested a review from tylerccarson April 13, 2026 12:27

ukumar-ks self-assigned this Apr 13, 2026

ukumar-ks marked this pull request as ready for review April 13, 2026 12:29

ukumar-ks requested review from THeflinKeeper and saldoukhov as code owners April 13, 2026 12:29

ukumar-ks removed the request for review from THeflinKeeper April 13, 2026 12:30

sali-ks requested a review from craiglurey April 16, 2026 05:49

tylerccarson reviewed Apr 17, 2026

View reviewed changes

Code changes as per review comments

93955ad

		@@ -0,0 +1,36 @@
		export const SdkDefaults = {
		CLIENT_VERSION: 'c17.0.0',

Conversation

ukumar-ks commented Apr 13, 2026

Login & Records Implementation

Summary

Authentication

Records

Sharing

Uh oh!

socket-security bot commented Apr 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tylerccarson left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

socket-security bot commented Apr 13, 2026 •

edited

Loading